home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 July: Mac OS SDK / Dev.CD Jul 99 SDK1.toast / Development Kits / Mac OS / Interfaces&Libraries / Universal / Interfaces / AIncludes / Folders.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  13.0 KB  |  370 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        Folders.a
  3. ;
  4. ;    Contains:    Folder Manager Interfaces.
  5. ;
  6. ;    Version:    Technology:    Mac OS 8
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__FOLDERS__') = 'UNDEFINED' THEN
  18. __FOLDERS__ SET 1
  19.  
  20.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  21.     include 'MacTypes.a'
  22.     ENDIF
  23.  
  24.  
  25. kOnSystemDisk                    EQU        -32768                ; previously was 0x8000 but that is an unsigned value whereas vRefNum is signed
  26.  
  27. kCreateFolder                    EQU        1
  28. kDontCreateFolder                EQU        0
  29.  
  30. kSystemFolderType                EQU        'macs'                ; the system folder 
  31. kDesktopFolderType                EQU        'desk'                ; the desktop folder; objects in this folder show on the desk top. 
  32. kTrashFolderType                EQU        'trsh'                ; the trash folder; objects in this folder show up in the trash 
  33. kWhereToEmptyTrashFolderType    EQU        'empt'                ; the "empty trash" folder; Finder starts empty from here down 
  34. kPrintMonitorDocsFolderType        EQU        'prnt'                ; Print Monitor documents 
  35. kStartupFolderType                EQU        'strt'                ; Finder objects (applications, documents, DAs, aliases, to...) to open at startup go here 
  36. kShutdownFolderType                EQU        'shdf'                ; Finder objects (applications, documents, DAs, aliases, to...) to open at shutdown go here 
  37. kAppleMenuFolderType            EQU        'amnu'                ; Finder objects to put into the Apple menu go here 
  38. kControlPanelFolderType            EQU        'ctrl'                ; Control Panels go here (may contain INITs) 
  39. kExtensionFolderType            EQU        'extn'                ; System extensions go here 
  40. kFontsFolderType                EQU        'font'                ; Fonts go here 
  41. kPreferencesFolderType            EQU        'pref'                ; preferences for applications go here 
  42. kTemporaryFolderType            EQU        'temp'                ; temporary files go here (deleted periodically, but don't rely on it.) 
  43. ; 
  44. ;    Note:     The FindFolder trap was not implemented until System 7.  If you want to call FindFolder
  45. ;            while running on System 6 machines, then define USE_FINDFOLDER_GLUE and link with
  46. ;            Interface.o which contains glue to implement FindFolder on pre-System 7 machines.
  47. ;
  48.  
  49.     IF &TYPE('USE_FINDFOLDER_GLUE') <> 'UNDEFINED' THEN
  50. ;
  51. ; pascal OSErr FindFolder(short vRefNum, OSType folderType, Boolean createFolder, short *foundVRefNum, long *foundDirID)
  52. ;
  53.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  54.         IMPORT_CFM_FUNCTION FindFolder
  55.     ENDIF
  56.  
  57.     ELSE
  58. ;
  59. ; pascal OSErr FindFolder(short vRefNum, OSType folderType, Boolean createFolder, short *foundVRefNum, long *foundDirID)
  60. ;
  61.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  62.         Macro
  63.         _FindFolder
  64.             moveq               #0,D0
  65.             dc.w                $A823
  66.         EndM
  67.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  68.         IMPORT_CFM_FUNCTION FindFolder
  69.     ENDIF
  70.  
  71.     ENDIF
  72. ;
  73. ; pascal OSErr ReleaseFolder(short vRefNum, OSType folderType)
  74. ;
  75.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  76.         Macro
  77.         _ReleaseFolder
  78.             moveq               #11,D0
  79.             dc.w                $A823
  80.         EndM
  81.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  82.         IMPORT_CFM_FUNCTION ReleaseFolder
  83.     ENDIF
  84.  
  85.  
  86.     IF ¬ TARGET_OS_MAC THEN
  87. ;  Since non-mac targets don't know about VRef's or DirID's, the Ex version returns
  88. ;   the found folder path.
  89. ; 
  90.  
  91. ;
  92. ; extern OSErr FindFolderEx(short vRefNum, OSType folderType, Boolean createFolder, short *foundVRefNum, long *foundDirID, char *foundFolder)
  93. ;
  94.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  95.         IMPORT_CFM_FUNCTION FindFolderEx
  96.     ENDIF
  97.  
  98.     ENDIF
  99. ; *****************************************
  100. ;  Extensible Folder Manager declarations 
  101. ; *****************************************
  102.  
  103. ; ***************************
  104. ;  Folder Manager constants 
  105. ; ***************************
  106.  
  107.  
  108. kExtensionDisabledFolderType    EQU        'extD'
  109. kControlPanelDisabledFolderType    EQU        'ctrD'
  110. kSystemExtensionDisabledFolderType EQU    'macD'
  111. kStartupItemsDisabledFolderType    EQU        'strD'
  112. kShutdownItemsDisabledFolderType EQU    'shdD'
  113. kApplicationsFolderType            EQU        'apps'
  114. kDocumentsFolderType            EQU        'docs'
  115.  
  116.                                                             ; new constants 
  117. kVolumeRootFolderType            EQU        'root'                ; root folder of a volume 
  118. kChewableItemsFolderType        EQU        'flnt'                ; items deleted at boot 
  119. kApplicationSupportFolderType    EQU        'asup'                ; third-party items and folders 
  120. kTextEncodingsFolderType        EQU        'ƒtex'                ; encoding tables 
  121. kStationeryFolderType            EQU        'odst'                ; stationery 
  122. kOpenDocFolderType                EQU        'odod'                ; OpenDoc root 
  123. kOpenDocShellPlugInsFolderType    EQU        'odsp'                ; OpenDoc Shell Plug-Ins in OpenDoc folder 
  124. kEditorsFolderType                EQU        'oded'                ; OpenDoc editors in MacOS Folder 
  125. kOpenDocEditorsFolderType        EQU        'ƒodf'                ; OpenDoc subfolder of Editors folder 
  126. kOpenDocLibrariesFolderType        EQU        'odlb'                ; OpenDoc libraries folder 
  127. kGenEditorsFolderType            EQU        'ƒedi'                ; CKH general editors folder at root level of Sys folder 
  128. kHelpFolderType                    EQU        'ƒhlp'                ; CKH help folder currently at root of system folder 
  129. kInternetPlugInFolderType        EQU        'ƒnet'                ; CKH internet plug ins for browsers and stuff 
  130. kModemScriptsFolderType            EQU        'ƒmod'                ; CKH modem scripts, get 'em OUT of the Extensions folder 
  131. kPrinterDescriptionFolderType    EQU        'ppdf'                ; CKH new folder at root of System folder for printer descs. 
  132. kPrinterDriverFolderType        EQU        'ƒprd'                ; CKH new folder at root of System folder for printer drivers 
  133. kScriptingAdditionsFolderType    EQU        'ƒscr'                ; CKH at root of system folder 
  134. kSharedLibrariesFolderType        EQU        'ƒlib'                ; CKH for general shared libs. 
  135. kVoicesFolderType                EQU        'fvoc'                ; CKH macintalk can live here 
  136. kControlStripModulesFolderType    EQU        'sdev'                ; CKH for control strip modules 
  137. kAssistantsFolderType            EQU        'astƒ'                ; SJF for Assistants (MacOS Setup Assistant, etc) 
  138. kUtilitiesFolderType            EQU        'utiƒ'                ; SJF for Utilities folder 
  139. kAppleExtrasFolderType            EQU        'aexƒ'                ; SJF for Apple Extras folder 
  140. kContextualMenuItemsFolderType    EQU        'cmnu'                ; SJF for Contextual Menu items 
  141. kMacOSReadMesFolderType            EQU        'morƒ'                ; SJF for MacOS ReadMes folder 
  142. kALMModulesFolderType            EQU        'walk'                ; EAS for Location Manager Module files except type 'thng' (within kExtensionFolderType) 
  143. kALMPreferencesFolderType        EQU        'trip'                ; EAS for Location Manager Preferences (within kPreferencesFolderType; contains kALMLocationsFolderType) 
  144. kALMLocationsFolderType            EQU        'fall'                ; EAS for Location Manager Locations (within kALMPreferencesFolderType) 
  145. kColorSyncProfilesFolderType    EQU        'prof'                ; for ColorSync™ Profiles 
  146. kThemesFolderType                EQU        'thme'                ; for Theme data files 
  147. kFavoritesFolderType            EQU        'favs'                ; Favorties folder for Navigation Services 
  148. kInternetFolderType                EQU        'intƒ'                ; Internet folder (root level of startup volume) 
  149. kAppearanceFolderType            EQU        'appr'                ; Appearance folder (root of system folder) 
  150. kSoundSetsFolderType            EQU        'snds'                ; Sound Sets folder (in Appearance folder) 
  151. kDesktopPicturesFolderType        EQU        'dtpƒ'                ; Desktop Pictures folder (in Appearance folder) 
  152. kInternetSearchSitesFolderType    EQU        'issf'                ; Internet Search Sites folder 
  153. kFindSupportFolderType            EQU        'fnds'                ; Find support folder 
  154. kFindByContentFolderType        EQU        'fbcf'                ; Find by content folder 
  155. kInstallerLogsFolderType        EQU        'ilgf'                ; Installer Logs folder 
  156. kScriptsFolderType                EQU        'scrƒ'                ; Scripts folder 
  157. kFolderActionsFolderType        EQU        'fasf'                ; Folder Actions Scripts folder 
  158. kLauncherItemsFolderType        EQU        'laun'                ; Launcher Items folder 
  159. kRecentApplicationsFolderType    EQU        'rapp'                ; Recent Applications folder 
  160. kRecentDocumentsFolderType        EQU        'rdoc'                ; Recent Documents folder 
  161. kRecentServersFolderType        EQU        'rsvr'                ; Recent Servers folder 
  162. kSpeakableItemsFolderType        EQU        'spki'                ; Speakable Items folder 
  163.  
  164. ;  FolderDescFlags values 
  165.  
  166. kCreateFolderAtBoot                EQU        $00000002
  167. kFolderCreatedInvisible            EQU        $00000004
  168. kFolderCreatedNameLocked        EQU        $00000008
  169. ; typedef UInt32                         FolderDescFlags
  170.  
  171. ;  FolderClass values 
  172.  
  173. kRelativeFolder                    EQU        'relf'
  174. kSpecialFolder                    EQU        'spcf'
  175. ; typedef OSType                         FolderClass
  176.  
  177. ;  special folder locations 
  178.  
  179. kBlessedFolder                    EQU        'blsf'
  180. kRootFolder                        EQU        'rotf'
  181. ; typedef OSType                         FolderType
  182.  
  183. ; typedef OSType                         FolderLocation
  184.  
  185.  
  186. FolderDesc                RECORD 0
  187. descSize                 ds.l    1                ; offset: $0 (0)
  188. foldType                 ds.l    1                ; offset: $4 (4)
  189. flags                     ds.l    1                ; offset: $8 (8)
  190. foldClass                 ds.l    1                ; offset: $C (12)
  191. foldLocation             ds.l    1                ; offset: $10 (16)
  192. badgeSignature             ds.l    1                ; offset: $14 (20)
  193. badgeType                 ds.l    1                ; offset: $18 (24)
  194. reserved                 ds.l    1                ; offset: $1C (28)
  195. name                     ds        StrFileName        ; offset: $20 (32)        ;  Str63 on MacOS
  196. sizeof                     EQU *                    ; size:   $60 (96)
  197.                         ENDR
  198. ; typedef struct FolderDesc *            FolderDescPtr
  199.  
  200.  
  201. ; typedef UInt32                         RoutingFlags
  202.  
  203. FolderRouting            RECORD 0
  204. descSize                 ds.l    1                ; offset: $0 (0)
  205. fileType                 ds.l    1                ; offset: $4 (4)
  206. routeFromFolder             ds.l    1                ; offset: $8 (8)
  207. routeToFolder             ds.l    1                ; offset: $C (12)
  208. flags                     ds.l    1                ; offset: $10 (16)
  209. sizeof                     EQU *                    ; size:   $14 (20)
  210.                         ENDR
  211. ; typedef struct FolderRouting *        FolderRoutingPtr
  212.  
  213. ;  routing constants 
  214. ; **************************
  215. ;  Folder Manager routines 
  216. ; **************************
  217. ;  Folder Manager administration routines 
  218. ;
  219. ; pascal OSErr AddFolderDescriptor(FolderType foldType, FolderDescFlags flags, FolderClass foldClass, FolderLocation foldLocation, OSType badgeSignature, OSType badgeType, ConstStrFileNameParam name, Boolean replaceFlag)
  220. ;
  221.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  222.         Macro
  223.         _AddFolderDescriptor
  224.             moveq               #32,D0
  225.             dc.w                $A823
  226.         EndM
  227.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  228.         IMPORT_CFM_FUNCTION AddFolderDescriptor
  229.     ENDIF
  230.  
  231. ;
  232. ; pascal OSErr GetFolderDescriptor(FolderType foldType, Size descSize, FolderDesc *foldDesc)
  233. ;
  234.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  235.         Macro
  236.         _GetFolderDescriptor
  237.             moveq               #35,D0
  238.             dc.w                $A823
  239.         EndM
  240.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  241.         IMPORT_CFM_FUNCTION GetFolderDescriptor
  242.     ENDIF
  243.  
  244. ;
  245. ; pascal OSErr GetFolderTypes(UInt32 requestedTypeCount, UInt32 *totalTypeCount, FolderType *theTypes)
  246. ;
  247.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  248.         Macro
  249.         _GetFolderTypes
  250.             moveq               #36,D0
  251.             dc.w                $A823
  252.         EndM
  253.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  254.         IMPORT_CFM_FUNCTION GetFolderTypes
  255.     ENDIF
  256.  
  257. ;
  258. ; pascal OSErr RemoveFolderDescriptor(FolderType foldType)
  259. ;
  260.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  261.         Macro
  262.         _RemoveFolderDescriptor
  263.             moveq               #33,D0
  264.             dc.w                $A823
  265.         EndM
  266.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  267.         IMPORT_CFM_FUNCTION RemoveFolderDescriptor
  268.     ENDIF
  269.  
  270. ;  legacy routines 
  271. ;
  272. ; pascal OSErr GetFolderName(short vRefNum, OSType foldType, short *foundVRefNum, StrFileName name)
  273. ;
  274.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  275.         Macro
  276.         _GetFolderName
  277.             moveq               #14,D0
  278.             dc.w                $A823
  279.         EndM
  280.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  281.         IMPORT_CFM_FUNCTION GetFolderName
  282.     ENDIF
  283.  
  284. ;  routing routines 
  285. ;
  286. ; pascal OSErr AddFolderRouting(OSType fileType, FolderType routeFromFolder, FolderType routeToFolder, RoutingFlags flags, Boolean replaceFlag)
  287. ;
  288.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  289.         Macro
  290.         _AddFolderRouting
  291.             moveq               #38,D0
  292.             dc.w                $A823
  293.         EndM
  294.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  295.         IMPORT_CFM_FUNCTION AddFolderRouting
  296.     ENDIF
  297.  
  298. ;
  299. ; pascal OSErr RemoveFolderRouting(OSType fileType, FolderType routeFromFolder)
  300. ;
  301.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  302.         Macro
  303.         _RemoveFolderRouting
  304.             moveq               #39,D0
  305.             dc.w                $A823
  306.         EndM
  307.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  308.         IMPORT_CFM_FUNCTION RemoveFolderRouting
  309.     ENDIF
  310.  
  311. ;
  312. ; pascal OSErr FindFolderRouting(OSType fileType, FolderType routeFromFolder, FolderType *routeToFolder, RoutingFlags *flags)
  313. ;
  314.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  315.         Macro
  316.         _FindFolderRouting
  317.             moveq               #34,D0
  318.             dc.w                $A823
  319.         EndM
  320.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  321.         IMPORT_CFM_FUNCTION FindFolderRouting
  322.     ENDIF
  323.  
  324. ;
  325. ; pascal OSErr GetFolderRoutings(UInt32 requestedRoutingCount, UInt32 *totalRoutingCount, Size routingSize, FolderRouting *theRoutings)
  326. ;
  327.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  328.         Macro
  329.         _GetFolderRoutings
  330.             moveq               #30,D0
  331.             dc.w                $A823
  332.         EndM
  333.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  334.         IMPORT_CFM_FUNCTION GetFolderRoutings
  335.     ENDIF
  336.  
  337. ;
  338. ; pascal OSErr InvalidateFolderDescriptorCache(short vRefNum, long dirID)
  339. ;
  340.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  341.         Macro
  342.         _InvalidateFolderDescriptorCache
  343.             moveq               #37,D0
  344.             dc.w                $A823
  345.         EndM
  346.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  347.         IMPORT_CFM_FUNCTION InvalidateFolderDescriptorCache
  348.     ENDIF
  349.  
  350. ;
  351. ; pascal OSErr IdentifyFolder(short vRefNum, long dirID, FolderType *foldType)
  352. ;
  353.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  354.         Macro
  355.         _IdentifyFolder
  356.             moveq               #31,D0
  357.             dc.w                $A823
  358.         EndM
  359.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  360.         IMPORT_CFM_FUNCTION IdentifyFolder
  361.     ENDIF
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.     ENDIF ; __FOLDERS__ 
  369.  
  370.